<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>EntityProviderManagerImpl xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../../../apidocs/org/sakaiproject/entitybus/impl/entityprovider/EntityProviderManagerImpl.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*</em></em>
<a name="2" href="#2">2</a>   <em> * $Id: EntityProviderManagerImpl.html 12 2009-01-29 12:00:24Z azeckoski $</em>
<a name="3" href="#3">3</a>   <em> * $URL: http://entitybus.googlecode.com/svn/maven/site/entitybus-impl/xref/org/sakaiproject/entitybus/impl/entityprovider/EntityProviderManagerImpl.html $</em>
<a name="4" href="#4">4</a>   <em> * EBlogic.java - entity-broker - Apr 15, 2008 4:29:18 PM - azeckoski</em>
<a name="5" href="#5">5</a>   <em> **************************************************************************</em>
<a name="6" href="#6">6</a>   <em> * Copyright (c) 2007, 2008 Sakai Foundation</em>
<a name="7" href="#7">7</a>   <em> *</em>
<a name="8" href="#8">8</a>   <em> * Licensed under the Educational Community License, Version 2.0 (the "License");</em>
<a name="9" href="#9">9</a>   <em> * you may not use this file except in compliance with the License.</em>
<a name="10" href="#10">10</a>  <em> * You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a>  <em> *</em>
<a name="12" href="#12">12</a>  <em> *       <a href="http://www.osedu.org/licenses/ECL-2.0" target="alexandria_uri">http://www.osedu.org/licenses/ECL-2.0</a></em>
<a name="13" href="#13">13</a>  <em> *</em>
<a name="14" href="#14">14</a>  <em> * Unless required by applicable law or agreed to in writing, software</em>
<a name="15" href="#15">15</a>  <em> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="16" href="#16">16</a>  <em> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="17" href="#17">17</a>  <em> * See the License for the specific language governing permissions and</em>
<a name="18" href="#18">18</a>  <em> * limitations under the License.</em>
<a name="19" href="#19">19</a>  <em> */</em>
<a name="20" href="#20">20</a>  
<a name="21" href="#21">21</a>  <strong>package</strong> org.sakaiproject.entitybus.impl.entityprovider;
<a name="22" href="#22">22</a>  
<a name="23" href="#23">23</a>  <strong>import</strong> java.io.Serializable;
<a name="24" href="#24">24</a>  <strong>import</strong> java.util.ArrayList;
<a name="25" href="#25">25</a>  <strong>import</strong> java.util.Collections;
<a name="26" href="#26">26</a>  <strong>import</strong> java.util.Comparator;
<a name="27" href="#27">27</a>  <strong>import</strong> java.util.HashMap;
<a name="28" href="#28">28</a>  <strong>import</strong> java.util.HashSet;
<a name="29" href="#29">29</a>  <strong>import</strong> java.util.Iterator;
<a name="30" href="#30">30</a>  <strong>import</strong> java.util.List;
<a name="31" href="#31">31</a>  <strong>import</strong> java.util.Map;
<a name="32" href="#32">32</a>  <strong>import</strong> java.util.Set;
<a name="33" href="#33">33</a>  <strong>import</strong> java.util.UUID;
<a name="34" href="#34">34</a>  <strong>import</strong> java.util.Map.Entry;
<a name="35" href="#35">35</a>  
<a name="36" href="#36">36</a>  <strong>import</strong> org.apache.commons.logging.Log;
<a name="37" href="#37">37</a>  <strong>import</strong> org.apache.commons.logging.LogFactory;
<a name="38" href="#38">38</a>  <strong>import</strong> org.azeckoski.reflectutils.ReflectUtils;
<a name="39" href="#39">39</a>  <strong>import</strong> org.azeckoski.reflectutils.refmap.ReferenceMap;
<a name="40" href="#40">40</a>  <strong>import</strong> org.azeckoski.reflectutils.refmap.ReferenceType;
<a name="41" href="#41">41</a>  <strong>import</strong> org.sakaiproject.entitybus.EntityReference;
<a name="42" href="#42">42</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.CoreEntityProvider;
<a name="43" href="#43">43</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.EntityProvider;
<a name="44" href="#44">44</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.EntityProviderManager;
<a name="45" href="#45">45</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.EntityProviderMethodStore;
<a name="46" href="#46">46</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.ActionsDefineable;
<a name="47" href="#47">47</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.ActionsExecutable;
<a name="48" href="#48">48</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.ActionsExecutionControllable;
<a name="49" href="#49">49</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.DescribePropertiesable;
<a name="50" href="#50">50</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.Describeable;
<a name="51" href="#51">51</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.RedirectControllable;
<a name="52" href="#52">52</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.RedirectDefinable;
<a name="53" href="#53">53</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.Redirectable;
<a name="54" href="#54">54</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.RequestAware;
<a name="55" href="#55">55</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.RequestStorable;
<a name="56" href="#56">56</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.CustomAction;
<a name="57" href="#57">57</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.EntityProviderListener;
<a name="58" href="#58">58</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.RequestGetterWrite;
<a name="59" href="#59">59</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.RequestStorageWrite;
<a name="60" href="#60">60</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.URLRedirect;
<a name="61" href="#61">61</a>  <strong>import</strong> org.sakaiproject.entitybus.providers.EntityPropertiesService;
<a name="62" href="#62">62</a>  <strong>import</strong> org.sakaiproject.entitybus.providers.EntityRequestHandler;
<a name="63" href="#63">63</a>  <strong>import</strong> org.sakaiproject.entitybus.util.core.EntityProviderMethodStoreImpl;
<a name="64" href="#64">64</a>  
<a name="65" href="#65">65</a>  <em>/**<em>*</em></em>
<a name="66" href="#66">66</a>  <em> * Base implementation of the entity provider manager</em>
<a name="67" href="#67">67</a>  <em> * </em>
<a name="68" href="#68">68</a>  <em> * @author Aaron Zeckoski (aaronz@vt.edu)</em>
<a name="69" href="#69">69</a>  <em> * @author Antranig Basman (antranig@caret.cam.ac.uk)</em>
<a name="70" href="#70">70</a>  <em> */</em>
<a name="71" href="#71">71</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../../org/sakaiproject/entitybus/impl/entityprovider/EntityProviderManagerImpl.html">EntityProviderManagerImpl</a> implements EntityProviderManager {
<a name="72" href="#72">72</a>  
<a name="73" href="#73">73</a>      <strong>private</strong> <strong>static</strong> Log log = LogFactory.getLog(EntityProviderManagerImpl.<strong>class</strong>);
<a name="74" href="#74">74</a>  
<a name="75" href="#75">75</a>      <em>/**<em>*</em></em>
<a name="76" href="#76">76</a>  <em>     * Empty constructor</em>
<a name="77" href="#77">77</a>  <em>     */</em>
<a name="78" href="#78">78</a>      <strong>protected</strong> <a href="../../../../../org/sakaiproject/entitybus/impl/entityprovider/EntityProviderManagerImpl.html">EntityProviderManagerImpl</a>() { }
<a name="79" href="#79">79</a>  
<a name="80" href="#80">80</a>      <em>/**<em>*</em></em>
<a name="81" href="#81">81</a>  <em>     * Base constructor</em>
<a name="82" href="#82">82</a>  <em>     * @param requestStorage the request storage service (writeable)</em>
<a name="83" href="#83">83</a>  <em>     * @param requestGetter the request getter service</em>
<a name="84" href="#84">84</a>  <em>     * @param entityProperties the entity properties service</em>
<a name="85" href="#85">85</a>  <em>     * @param entityProviderMethodStore the provider method storage</em>
<a name="86" href="#86">86</a>  <em>     */</em>
<a name="87" href="#87">87</a>      <strong>public</strong> <a href="../../../../../org/sakaiproject/entitybus/impl/entityprovider/EntityProviderManagerImpl.html">EntityProviderManagerImpl</a>(RequestStorageWrite requestStorage, RequestGetterWrite requestGetter,
<a name="88" href="#88">88</a>              EntityPropertiesService entityProperties, EntityProviderMethodStore entityProviderMethodStore) {
<a name="89" href="#89">89</a>          <strong>super</strong>();
<a name="90" href="#90">90</a>          <strong>this</strong>.requestStorage = requestStorage;
<a name="91" href="#91">91</a>          <strong>this</strong>.requestGetter = requestGetter;
<a name="92" href="#92">92</a>          <strong>this</strong>.entityProperties = entityProperties;
<a name="93" href="#93">93</a>          <strong>this</strong>.entityProviderMethodStore = entityProviderMethodStore;
<a name="94" href="#94">94</a>          init();
<a name="95" href="#95">95</a>      }
<a name="96" href="#96">96</a>  
<a name="97" href="#97">97</a>      <strong>private</strong> RequestStorageWrite requestStorage;
<a name="98" href="#98">98</a>      <strong>private</strong> RequestGetterWrite requestGetter;
<a name="99" href="#99">99</a>      <strong>private</strong> EntityPropertiesService entityProperties;
<a name="100" href="#100">100</a>     <strong>private</strong> EntityProviderMethodStore entityProviderMethodStore;
<a name="101" href="#101">101</a> 
<a name="102" href="#102">102</a>     <strong>protected</strong> ReferenceMap&lt;String, EntityProvider> prefixMap = <strong>new</strong> ReferenceMap&lt;String, EntityProvider>(ReferenceType.STRONG, ReferenceType.SOFT);
<a name="103" href="#103">103</a> 
<a name="104" href="#104">104</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="105" href="#105">105</a>     <strong>protected</strong> ReferenceMap&lt;String, EntityProviderListener> listenerMap = <strong>new</strong> ReferenceMap&lt;String, EntityProviderListener>(ReferenceType.STRONG, ReferenceType.SOFT);
<a name="106" href="#106">106</a> 
<a name="107" href="#107">107</a>     <em class="comment">// old CHMs were switched to RMs to avoid holding strong references and allowing clean classloader unloads</em>
<a name="108" href="#108">108</a>     <em class="comment">// protected ConcurrentMap&lt;String, EntityProvider> prefixMap = new ConcurrentHashMap&lt;String, EntityProvider>();</em>
<a name="109" href="#109">109</a>     <em class="comment">// protected ConcurrentMap&lt;String, ReferenceParseable> parseMap = new ConcurrentHashMap&lt;String, ReferenceParseable>();</em>
<a name="110" href="#110">110</a> 
<a name="111" href="#111">111</a> 
<a name="112" href="#112">112</a>     <strong>public</strong> <strong>void</strong> init() {
<a name="113" href="#113">113</a>         log.info(<span class="string">"init"</span>);
<a name="114" href="#114">114</a>         <em class="comment">// register the describe and batch prefixes to reserve them</em>
<a name="115" href="#115">115</a>         registerEntityProvider(
<a name="116" href="#116">116</a>                 <strong>new</strong> EntityProvider() {
<a name="117" href="#117">117</a>                     <strong>public</strong> String getEntityPrefix() {
<a name="118" href="#118">118</a>                         <strong>return</strong> EntityRequestHandler.DESCRIBE;
<a name="119" href="#119">119</a>                     }
<a name="120" href="#120">120</a>                 }
<a name="121" href="#121">121</a>         );
<a name="122" href="#122">122</a>         registerEntityProvider(
<a name="123" href="#123">123</a>                 <strong>new</strong> EntityProvider() {
<a name="124" href="#124">124</a>                     <strong>public</strong> String getEntityPrefix() {
<a name="125" href="#125">125</a>                         <strong>return</strong> EntityRequestHandler.BATCH;
<a name="126" href="#126">126</a>                     }
<a name="127" href="#127">127</a>                 }
<a name="128" href="#128">128</a>         );
<a name="129" href="#129">129</a>     }
<a name="130" href="#130">130</a> 
<a name="131" href="#131">131</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="132" href="#132">132</a> <em class="comment">     * @see org.sakaiproject.entitybus.managers.EntityProviderManager#getProviderByPrefix(java.lang.String)</em>
<a name="133" href="#133">133</a> <em class="comment">     */</em>
<a name="134" href="#134">134</a>     <strong>public</strong> EntityProvider getProviderByPrefix(String prefix) {
<a name="135" href="#135">135</a>         EntityProvider provider = getProviderByPrefixAndCapability(prefix, CoreEntityProvider.<strong>class</strong>);
<a name="136" href="#136">136</a>         <strong>if</strong> (provider == <strong>null</strong>) {
<a name="137" href="#137">137</a>             provider = getProviderByPrefixAndCapability(prefix, EntityProvider.<strong>class</strong>);
<a name="138" href="#138">138</a>         }
<a name="139" href="#139">139</a>         <strong>return</strong> provider;
<a name="140" href="#140">140</a>     }
<a name="141" href="#141">141</a> 
<a name="142" href="#142">142</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="143" href="#143">143</a> <em class="comment">     * @see org.sakaiproject.entitybus.entityprovider.EntityProviderManager#getProviderByPrefixAndCapability(java.lang.String, java.lang.Class)</em>
<a name="144" href="#144">144</a> <em class="comment">     */</em>
<a name="145" href="#145">145</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="146" href="#146">146</a>     <strong>public</strong> &lt;T <strong>extends</strong> EntityProvider> T getProviderByPrefixAndCapability(String prefix, Class&lt;T> capability) {
<a name="147" href="#147">147</a>         T provider = <strong>null</strong>;
<a name="148" href="#148">148</a>         <strong>if</strong> (capability == <strong>null</strong>) {
<a name="149" href="#149">149</a>             <strong>throw</strong> <strong>new</strong> NullPointerException(<span class="string">"capability cannot be null"</span>);
<a name="150" href="#150">150</a>         }
<a name="151" href="#151">151</a>         String bikey = getBiKey(prefix, capability);
<a name="152" href="#152">152</a>         provider = (T) prefixMap.get(bikey);
<a name="153" href="#153">153</a>         <strong>return</strong> provider;
<a name="154" href="#154">154</a>     }
<a name="155" href="#155">155</a> 
<a name="156" href="#156">156</a>     <em class="comment">/*</em>
<a name="157" href="#157">157</a> <em class="comment">     * (non-Javadoc)</em>
<a name="158" href="#158">158</a> <em class="comment">     * @see org.sakaiproject.entitybus.entityprovider.EntityProviderManager#getRegisteredPrefixes()</em>
<a name="159" href="#159">159</a> <em class="comment">     */</em>
<a name="160" href="#160">160</a>     <strong>public</strong> Set&lt;String> getRegisteredPrefixes() {
<a name="161" href="#161">161</a>         Set&lt;String> togo = <strong>new</strong> HashSet&lt;String>();
<a name="162" href="#162">162</a>         <strong>for</strong> (String bikey : prefixMap.keySet()) {
<a name="163" href="#163">163</a>             togo.add(getPrefix(bikey));
<a name="164" href="#164">164</a>         }
<a name="165" href="#165">165</a>         <strong>return</strong> togo;
<a name="166" href="#166">166</a>     }
<a name="167" href="#167">167</a> 
<a name="168" href="#168">168</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="169" href="#169">169</a> <em class="comment">     * @see org.sakaiproject.entitybus.entityprovider.EntityProviderManager#getPrefixCapabilities(java.lang.String)</em>
<a name="170" href="#170">170</a> <em class="comment">     */</em>
<a name="171" href="#171">171</a>     <strong>public</strong> List&lt;Class&lt;? <strong>extends</strong> EntityProvider>> getPrefixCapabilities(String prefix) {
<a name="172" href="#172">172</a>         List&lt;Class&lt;? <strong>extends</strong> EntityProvider>> caps = <strong>new</strong> ArrayList&lt;Class&lt;? <strong>extends</strong> EntityProvider>>();
<a name="173" href="#173">173</a>         <strong>for</strong> (String bikey : prefixMap.keySet()) {
<a name="174" href="#174">174</a>             String curPrefix = EntityProviderManagerImpl.getPrefix(bikey);
<a name="175" href="#175">175</a>             <strong>if</strong> (curPrefix.equals(prefix)) {
<a name="176" href="#176">176</a>                 <strong>try</strong> {
<a name="177" href="#177">177</a>                     Class&lt;? <strong>extends</strong> EntityProvider> capability = getCapability(bikey);
<a name="178" href="#178">178</a>                     caps.add( capability );
<a name="179" href="#179">179</a>                 } <strong>catch</strong> (RuntimeException e) {
<a name="180" href="#180">180</a>                     <em class="comment">// added because there will be times where we cannot resolve capabilities </em>
<a name="181" href="#181">181</a>                     <em class="comment">// because of shifting ClassLoaders or CL visibility and that should not cause this to die</em>
<a name="182" href="#182">182</a>                     log.warn(<span class="string">"getPrefixCapabilities: Unable to retrieve class for capability bikey ("</span>+bikey+<span class="string">"), skipping this capability"</span>);
<a name="183" href="#183">183</a>                 }
<a name="184" href="#184">184</a>             }
<a name="185" href="#185">185</a>         }
<a name="186" href="#186">186</a>         Collections.sort(caps, <strong>new</strong> ClassComparator());
<a name="187" href="#187">187</a>         <strong>return</strong> caps;
<a name="188" href="#188">188</a>     }
<a name="189" href="#189">189</a> 
<a name="190" href="#190">190</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="191" href="#191">191</a> <em class="comment">     * @see org.sakaiproject.entitybus.entityprovider.EntityProviderManager#getRegisteredEntityCapabilities()</em>
<a name="192" href="#192">192</a> <em class="comment">     */</em>
<a name="193" href="#193">193</a>     <strong>public</strong> Map&lt;String, List&lt;Class&lt;? <strong>extends</strong> EntityProvider>>> getRegisteredEntityCapabilities() {
<a name="194" href="#194">194</a>         Map&lt;String, List&lt;Class&lt;? <strong>extends</strong> EntityProvider>>> m = <strong>new</strong> HashMap&lt;String, List&lt;Class&lt;? <strong>extends</strong> EntityProvider>>>();
<a name="195" href="#195">195</a>         ArrayList&lt;String> list = <strong>new</strong> ArrayList&lt;String>( prefixMap.keySet() );
<a name="196" href="#196">196</a>         Collections.sort(list);
<a name="197" href="#197">197</a>         <strong>for</strong> (String bikey : list) {
<a name="198" href="#198">198</a>             String prefix = getPrefix(bikey);
<a name="199" href="#199">199</a>             <strong>if</strong> (! m.containsKey(prefix)) {
<a name="200" href="#200">200</a>                 m.put(prefix, <strong>new</strong> ArrayList&lt;Class&lt;? <strong>extends</strong> EntityProvider>>());
<a name="201" href="#201">201</a>             }
<a name="202" href="#202">202</a>             <strong>try</strong> {
<a name="203" href="#203">203</a>                 Class&lt;? <strong>extends</strong> EntityProvider> capability = getCapability(bikey);
<a name="204" href="#204">204</a>                 m.get(prefix).add( capability );
<a name="205" href="#205">205</a>             } <strong>catch</strong> (RuntimeException e) {
<a name="206" href="#206">206</a>                 <em class="comment">// added because there will be times where we cannot resolve capabilities </em>
<a name="207" href="#207">207</a>                 <em class="comment">// because of shifting ClassLoaders or CL visibility and that should not cause this to die</em>
<a name="208" href="#208">208</a>                 log.warn(<span class="string">"getRegisteredEntityCapabilities: Unable to retrieve class for capability bikey ("</span>+bikey+<span class="string">"), skipping this capability"</span>);
<a name="209" href="#209">209</a>             }
<a name="210" href="#210">210</a>         }      
<a name="211" href="#211">211</a>         <strong>return</strong> m;
<a name="212" href="#212">212</a>     }
<a name="213" href="#213">213</a> 
<a name="214" href="#214">214</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="215" href="#215">215</a> <em class="comment">     * @see org.sakaiproject.entitybus.entityprovider.EntityProviderManager#getProvidersByCapability(java.lang.Class)</em>
<a name="216" href="#216">216</a> <em class="comment">     */</em>
<a name="217" href="#217">217</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="218" href="#218">218</a>     <strong>public</strong> &lt;T <strong>extends</strong> EntityProvider> List&lt;T> getProvidersByCapability(Class&lt;T> capability) {
<a name="219" href="#219">219</a>         ArrayList&lt;T> providers = <strong>new</strong> ArrayList&lt;T>();
<a name="220" href="#220">220</a>         String capName = capability.getName();
<a name="221" href="#221">221</a>         <strong>for</strong> (Entry&lt;String, EntityProvider> entry : prefixMap.entrySet()) {
<a name="222" href="#222">222</a>             String name = EntityProviderManagerImpl.getCapabilityName(entry.getKey());
<a name="223" href="#223">223</a>             <strong>if</strong> (capName.equals(name)) {
<a name="224" href="#224">224</a>                 providers.add((T)entry.getValue());
<a name="225" href="#225">225</a>             }
<a name="226" href="#226">226</a>         }
<a name="227" href="#227">227</a>         Collections.sort(providers, <strong>new</strong> EntityProviderComparator());
<a name="228" href="#228">228</a>         <strong>return</strong> providers;
<a name="229" href="#229">229</a>     }
<a name="230" href="#230">230</a> 
<a name="231" href="#231">231</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="232" href="#232">232</a> <em class="comment">     * @see org.sakaiproject.entitybus.entityprovider.EntityProviderManager#getPrefixesByCapability(java.lang.Class)</em>
<a name="233" href="#233">233</a> <em class="comment">     */</em>
<a name="234" href="#234">234</a>     <strong>public</strong> &lt;T <strong>extends</strong> EntityProvider> List&lt;String> getPrefixesByCapability(Class&lt;T> capability) {
<a name="235" href="#235">235</a>         ArrayList&lt;String> prefixes = <strong>new</strong> ArrayList&lt;String>();
<a name="236" href="#236">236</a>         String capName = capability.getName();
<a name="237" href="#237">237</a>         <strong>for</strong> (Entry&lt;String, EntityProvider> entry : prefixMap.entrySet()) {
<a name="238" href="#238">238</a>             String name = EntityProviderManagerImpl.getCapabilityName(entry.getKey());
<a name="239" href="#239">239</a>             <strong>if</strong> (capName.equals(name)) {
<a name="240" href="#240">240</a>                 prefixes.add( EntityProviderManagerImpl.getPrefix(entry.getKey()) );
<a name="241" href="#241">241</a>             }
<a name="242" href="#242">242</a>         }
<a name="243" href="#243">243</a>         Collections.sort(prefixes);
<a name="244" href="#244">244</a>         <strong>return</strong> prefixes;
<a name="245" href="#245">245</a>     }
<a name="246" href="#246">246</a> 
<a name="247" href="#247">247</a>     <em class="comment">/*</em>
<a name="248" href="#248">248</a> <em class="comment">     * (non-Javadoc)</em>
<a name="249" href="#249">249</a> <em class="comment">     * @see org.sakaiproject.entitybus.entityprovider.EntityProviderManager#registerEntityProvider(org.sakaiproject.entitybus.entityprovider.EntityProvider)</em>
<a name="250" href="#250">250</a> <em class="comment">     */</em>
<a name="251" href="#251">251</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="252" href="#252">252</a>     <strong>public</strong> <strong>void</strong> registerEntityProvider(EntityProvider entityProvider) {
<a name="253" href="#253">253</a>         <strong>if</strong> (entityProvider == <strong>null</strong>) {
<a name="254" href="#254">254</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"entityProvider cannot be null"</span>);
<a name="255" href="#255">255</a>         }
<a name="256" href="#256">256</a>         String prefix = <strong>new</strong> String( entityProvider.getEntityPrefix() ); <em class="comment">// copy to make sure this string is in the EB ClassLoader</em>
<a name="257" href="#257">257</a>         <strong>new</strong> EntityReference(prefix, <span class="string">""</span>); <em class="comment">// this checks the prefix is valid</em>
<a name="258" href="#258">258</a>         <em class="comment">// we are now registering describe ourselves</em>
<a name="259" href="#259">259</a>         <em class="comment">//      if (EntityRequestHandler.DESCRIBE.equals(prefix)) {</em>
<a name="260" href="#260">260</a>         <em class="comment">//         throw new IllegalArgumentException(EntityRequestHandler.DESCRIBE + " is a reserved prefix, it cannot be used");</em>
<a name="261" href="#261">261</a>         <em class="comment">//      }</em>
<a name="262" href="#262">262</a>         List&lt;Class&lt;? <strong>extends</strong> EntityProvider>> superclasses = extractCapabilities(entityProvider);
<a name="263" href="#263">263</a>         <strong>int</strong> count = 0;
<a name="264" href="#264">264</a>         <strong>for</strong> (Class&lt;? <strong>extends</strong> EntityProvider> superclazz : superclasses) {
<a name="265" href="#265">265</a>             registerPrefixCapability(prefix, superclazz, entityProvider);
<a name="266" href="#266">266</a>             count++;
<a name="267" href="#267">267</a>             <em class="comment">// special handling for certain EPs if needed</em>
<a name="268" href="#268">268</a>             <strong>if</strong> (superclazz.equals(RequestAware.<strong>class</strong>)) {
<a name="269" href="#269">269</a>                 <em class="comment">// need to shove in the requestGetter on registration</em>
<a name="270" href="#270">270</a>                 ((RequestAware)entityProvider).setRequestGetter(requestGetter);
<a name="271" href="#271">271</a>             } <strong>else</strong> <strong>if</strong> (superclazz.equals(RequestStorable.<strong>class</strong>)) {
<a name="272" href="#272">272</a>                 <em class="comment">// need to shove in the request storage on registration</em>
<a name="273" href="#273">273</a>                 ((RequestStorable)entityProvider).setRequestStorage(requestStorage);
<a name="274" href="#274">274</a>             } <strong>else</strong> <strong>if</strong> (superclazz.equals(ActionsExecutable.<strong>class</strong>)) {
<a name="275" href="#275">275</a>                 <em class="comment">// register the custom actions</em>
<a name="276" href="#276">276</a>                 CustomAction[] customActions = <strong>new</strong> CustomAction[0];
<a name="277" href="#277">277</a>                 <strong>if</strong> ( super<strong>class</strong>es.contains(ActionsExecutionControllable.<strong>class</strong>) 
<a name="278" href="#278">278</a>                         || super<strong>class</strong>es.contains(ActionsDefineable.<strong>class</strong>) ) {
<a name="279" href="#279">279</a>                     customActions = ((ActionsDefineable)entityProvider).defineActions();
<a name="280" href="#280">280</a>                     <strong>if</strong> (customActions == <strong>null</strong>) {
<a name="281" href="#281">281</a>                         <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"ActionsExecutable: defineActions returns null, "</span> +
<a name="282" href="#282">282</a>                         <span class="string">"it must return an array of custom actions (or you can use ActionsExecutable)"</span>);
<a name="283" href="#283">283</a>                     }
<a name="284" href="#284">284</a>                     <strong>if</strong> (!super<strong>class</strong>es.contains(ActionsExecutionControllable.<strong>class</strong>)) {
<a name="285" href="#285">285</a>                         <em class="comment">// do the actions defineable validation check</em>
<a name="286" href="#286">286</a>                         EntityProviderMethodStoreImpl.validateCustomActionMethods((ActionsDefineable)entityProvider);
<a name="287" href="#287">287</a>                     }
<a name="288" href="#288">288</a>                 } <strong>else</strong> {
<a name="289" href="#289">289</a>                     <em class="comment">// auto detect the custom actions</em>
<a name="290" href="#290">290</a>                     customActions = entityProviderMethodStore.findCustomActions(entityProvider, <strong>true</strong>);
<a name="291" href="#291">291</a>                 }
<a name="292" href="#292">292</a>                 <em class="comment">// register the actions</em>
<a name="293" href="#293">293</a>                 Map&lt;String,CustomAction> actions = <strong>new</strong> HashMap&lt;String, CustomAction>();
<a name="294" href="#294">294</a>                 <strong>for</strong> (CustomAction customAction : customActions) {
<a name="295" href="#295">295</a>                     String action = customAction.action;
<a name="296" href="#296">296</a>                     <strong>if</strong> (action == <strong>null</strong> || <span class="string">""</span>.equals(action) || EntityRequestHandler.DESCRIBE.equals(action)) {
<a name="297" href="#297">297</a>                         <strong>throw</strong> <strong>new</strong> IllegalStateException(<span class="string">"action keys cannot be null, '', or "</span>
<a name="298" href="#298">298</a>                                 +EntityRequestHandler.DESCRIBE+<span class="string">", invalid custom action defined in defineActions"</span>);
<a name="299" href="#299">299</a>                     }
<a name="300" href="#300">300</a>                     actions.put(action, customAction);
<a name="301" href="#301">301</a>                 }
<a name="302" href="#302">302</a>                 entityProviderMethodStore.setCustomActions(prefix, actions);
<a name="303" href="#303">303</a>             } <strong>else</strong> <strong>if</strong> (superclazz.equals(Describeable.<strong>class</strong>)) {
<a name="304" href="#304">304</a>                 <em class="comment">// need to load up the default properties into the cache</em>
<a name="305" href="#305">305</a>                 <strong>if</strong> (! super<strong>class</strong>es.contains(DescribePropertiesable.<strong>class</strong>)) {
<a name="306" href="#306">306</a>                     <em class="comment">// only load if the props are not defined elsewhere</em>
<a name="307" href="#307">307</a>                     ClassLoader cl = entityProvider.getClass().getClassLoader();
<a name="308" href="#308">308</a>                     entityProperties.loadProperties(prefix, <strong>null</strong>, cl);
<a name="309" href="#309">309</a>                 }
<a name="310" href="#310">310</a>             } <strong>else</strong> <strong>if</strong> (superclazz.equals(DescribePropertiesable.<strong>class</strong>)) {
<a name="311" href="#311">311</a>                 <em class="comment">// load up the properties from the provided CL and basename</em>
<a name="312" href="#312">312</a>                 ClassLoader cl = ((DescribePropertiesable)entityProvider).getResourceClassLoader();
<a name="313" href="#313">313</a>                 String baseName = ((DescribePropertiesable)entityProvider).getBaseName();
<a name="314" href="#314">314</a>                 entityProperties.loadProperties(prefix, baseName, cl);
<a name="315" href="#315">315</a>             } <strong>else</strong> <strong>if</strong> (superclazz.equals(Redirectable.<strong>class</strong>)) {
<a name="316" href="#316">316</a>                 URLRedirect[] redirects = entityProviderMethodStore.findURLRedirectMethods(entityProvider);
<a name="317" href="#317">317</a>                 entityProviderMethodStore.addURLRedirects(prefix, redirects);
<a name="318" href="#318">318</a>             } <strong>else</strong> <strong>if</strong> (superclazz.equals(RedirectDefinable.<strong>class</strong>)) {
<a name="319" href="#319">319</a>                 URLRedirect[] redirects = EntityProviderMethodStoreImpl.validateDefineableTemplates((RedirectDefinable)entityProvider);
<a name="320" href="#320">320</a>                 entityProviderMethodStore.addURLRedirects(prefix, redirects);
<a name="321" href="#321">321</a>             } <strong>else</strong> <strong>if</strong> (superclazz.equals(RedirectControllable.<strong>class</strong>)) {
<a name="322" href="#322">322</a>                 URLRedirect[] redirects = EntityProviderMethodStoreImpl.validateControllableTemplates((RedirectControllable)entityProvider);
<a name="323" href="#323">323</a>                 entityProviderMethodStore.addURLRedirects(prefix, redirects);
<a name="324" href="#324">324</a>             }
<a name="325" href="#325">325</a>         }
<a name="326" href="#326">326</a>         log.info(<span class="string">"EntityBroker: Registered entity provider ("</span>+entityProvider.getClass().getName()
<a name="327" href="#327">327</a>                 +<span class="string">") prefix ("</span>+prefix+<span class="string">") with "</span>+count+<span class="string">" capabilities"</span>);
<a name="328" href="#328">328</a> 
<a name="329" href="#329">329</a>         <em class="comment">// call the registered listeners</em>
<a name="330" href="#330">330</a>         <strong>for</strong> (Iterator&lt;EntityProviderListener> iterator = listenerMap.values().iterator(); iterator.hasNext();) {
<a name="331" href="#331">331</a>             EntityProviderListener&lt;? <strong>extends</strong> EntityProvider> providerListener = iterator.next();
<a name="332" href="#332">332</a>             callListener(providerListener, entityProvider);
<a name="333" href="#333">333</a>         }
<a name="334" href="#334">334</a>     }
<a name="335" href="#335">335</a> 
<a name="336" href="#336">336</a>     <em class="comment">/*</em>
<a name="337" href="#337">337</a> <em class="comment">     * (non-Javadoc)</em>
<a name="338" href="#338">338</a> <em class="comment">     * @see org.sakaiproject.entitybus.EntityProviderManager#unregisterEntityBroker(org.sakaiproject.entitybus.EntityProvider)</em>
<a name="339" href="#339">339</a> <em class="comment">     */</em>
<a name="340" href="#340">340</a>     <strong>public</strong> <strong>void</strong> unregisterEntityProvider(EntityProvider entityProvider) {
<a name="341" href="#341">341</a>         <strong>final</strong> String prefix = entityProvider.getEntityPrefix();
<a name="342" href="#342">342</a>         <strong>if</strong> (EntityRequestHandler.DESCRIBE.equals(prefix)) {
<a name="343" href="#343">343</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(EntityRequestHandler.DESCRIBE + <span class="string">" is a reserved prefix, it cannot be unregistered"</span>);
<a name="344" href="#344">344</a>         }
<a name="345" href="#345">345</a>         List&lt;Class&lt;? <strong>extends</strong> EntityProvider>> superclasses = extractCapabilities(entityProvider);
<a name="346" href="#346">346</a>         <strong>int</strong> count = 0;
<a name="347" href="#347">347</a>         <strong>for</strong> (Class&lt;? <strong>extends</strong> EntityProvider> capability : superclasses) {
<a name="348" href="#348">348</a>             <em class="comment">// ensure that the root EntityProvider is never absent from the map unless</em>
<a name="349" href="#349">349</a>             <em class="comment">// there is a call to unregisterEntityProviderByPrefix</em>
<a name="350" href="#350">350</a>             <strong>if</strong> (EntityProvider.<strong>class</strong>.equals(capability)) {
<a name="351" href="#351">351</a>                 <strong>if</strong> (getProviderByPrefixAndCapability(prefix, EntityProvider.<strong>class</strong>) != <strong>null</strong>) {
<a name="352" href="#352">352</a>                     <em class="comment">// needed to ensure that we always have at LEAST the base level EP for a registered entity</em>
<a name="353" href="#353">353</a>                     registerEntityProvider(<strong>new</strong> EntityProvider() {
<a name="354" href="#354">354</a>                         <strong>public</strong> String getEntityPrefix() {
<a name="355" href="#355">355</a>                             <strong>return</strong> prefix;
<a name="356" href="#356">356</a>                         }
<a name="357" href="#357">357</a>                     });
<a name="358" href="#358">358</a>                 }
<a name="359" href="#359">359</a>             } <strong>else</strong> {
<a name="360" href="#360">360</a>                 unregisterCapability(prefix, capability);
<a name="361" href="#361">361</a>                 count++;
<a name="362" href="#362">362</a>             }
<a name="363" href="#363">363</a>         }
<a name="364" href="#364">364</a>         <em class="comment">// clean up the properties cache</em>
<a name="365" href="#365">365</a>         entityProperties.unloadProperties(prefix);
<a name="366" href="#366">366</a> 
<a name="367" href="#367">367</a>         log.info(<span class="string">"EntityBroker: Unregistered entity provider ("</span>+entityProvider.getClass().getName()+<span class="string">") and "</span>+count+<span class="string">" capabilities"</span>);
<a name="368" href="#368">368</a>     }
<a name="369" href="#369">369</a> 
<a name="370" href="#370">370</a>     <em class="comment">/*</em>
<a name="371" href="#371">371</a> <em class="comment">     * (non-Javadoc)</em>
<a name="372" href="#372">372</a> <em class="comment">     * @see org.sakaiproject.entitybus.entityprovider.EntityProviderManager#unregisterEntityProviderCapability(java.lang.String,</em>
<a name="373" href="#373">373</a> <em class="comment">     *      java.lang.Class)</em>
<a name="374" href="#374">374</a> <em class="comment">     */</em>
<a name="375" href="#375">375</a>     <strong>public</strong> <strong>void</strong> unregisterCapability(String prefix, Class&lt;? <strong>extends</strong> EntityProvider> capability) {
<a name="376" href="#376">376</a>         <strong>if</strong> (prefix == <strong>null</strong> || capability == <strong>null</strong>) {
<a name="377" href="#377">377</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"prefix and capability cannot be null"</span>);
<a name="378" href="#378">378</a>         }
<a name="379" href="#379">379</a>         <strong>if</strong> (EntityProvider.<strong>class</strong>.equals(capability)) {
<a name="380" href="#380">380</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(
<a name="381" href="#381">381</a>             <span class="string">"Cannot separately unregister root EntityProvider capability - use unregisterEntityProviderByPrefix instead"</span>);
<a name="382" href="#382">382</a>         }
<a name="383" href="#383">383</a>         String key = getBiKey(prefix, capability);
<a name="384" href="#384">384</a>         prefixMap.remove(key);
<a name="385" href="#385">385</a>         <em class="comment">// do any cleanup that needs to be done when unregistering</em>
<a name="386" href="#386">386</a>         <strong>if</strong> (ActionsExecutable.<strong>class</strong>.equals(capability)) {
<a name="387" href="#387">387</a>             <em class="comment">// clean up the list of custom actions</em>
<a name="388" href="#388">388</a>             entityProviderMethodStore.removeCustomActions(prefix);
<a name="389" href="#389">389</a>         } <strong>else</strong> <strong>if</strong> (Describeable.<strong>class</strong>.isAssignableFrom(capability)) {
<a name="390" href="#390">390</a>             <em class="comment">// clean up properties record</em>
<a name="391" href="#391">391</a>             entityProperties.unloadProperties(prefix);
<a name="392" href="#392">392</a>         } <strong>else</strong> <strong>if</strong> (Redirectable.<strong>class</strong>.isAssignableFrom(capability)) {
<a name="393" href="#393">393</a>             <em class="comment">// clean up the redirect URLs record</em>
<a name="394" href="#394">394</a>             entityProviderMethodStore.removeURLRedirects(prefix);
<a name="395" href="#395">395</a>         }
<a name="396" href="#396">396</a>         log.info(<span class="string">"EntityBroker: Unregistered entity provider capability ("</span>+capability.getName()+<span class="string">") for prefix ("</span>+prefix+<span class="string">")"</span>);
<a name="397" href="#397">397</a>     }
<a name="398" href="#398">398</a> 
<a name="399" href="#399">399</a>     <em class="comment">/*</em>
<a name="400" href="#400">400</a> <em class="comment">     * (non-Javadoc)</em>
<a name="401" href="#401">401</a> <em class="comment">     * @see org.sakaiproject.entitybus.EntityProviderManager#unregisterEntityProviderByPrefix(java.lang.String)</em>
<a name="402" href="#402">402</a> <em class="comment">     */</em>
<a name="403" href="#403">403</a>     <strong>public</strong> <strong>void</strong> unregisterEntityProviderByPrefix(String prefix) {
<a name="404" href="#404">404</a>         <strong>if</strong> (prefix == <strong>null</strong>) {
<a name="405" href="#405">405</a>             <strong>throw</strong> <strong>new</strong> NullPointerException(<span class="string">"prefix cannot be null"</span>);
<a name="406" href="#406">406</a>         }
<a name="407" href="#407">407</a>         <strong>for</strong> (String bikey : prefixMap.keySet()) {
<a name="408" href="#408">408</a>             String keypref = getPrefix(bikey);
<a name="409" href="#409">409</a>             <strong>if</strong> (keypref.equals(prefix)) {
<a name="410" href="#410">410</a>                 prefixMap.remove(bikey);
<a name="411" href="#411">411</a>             }
<a name="412" href="#412">412</a>         }
<a name="413" href="#413">413</a>         log.info(<span class="string">"EntityBroker: Unregistered entity prefix ("</span>+prefix+<span class="string">")"</span>);
<a name="414" href="#414">414</a>     }
<a name="415" href="#415">415</a> 
<a name="416" href="#416">416</a>     <em>/**<em>*</em></em>
<a name="417" href="#417">417</a> <em>     * Allows for easy registration of a prefix and capability</em>
<a name="418" href="#418">418</a> <em>     * </em>
<a name="419" href="#419">419</a> <em>     * @param prefix</em>
<a name="420" href="#420">420</a> <em>     * @param capability</em>
<a name="421" href="#421">421</a> <em>     * @param provider</em>
<a name="422" href="#422">422</a> <em>     * @return true if the provider is newly registered, false if it was already registered</em>
<a name="423" href="#423">423</a> <em>     */</em>
<a name="424" href="#424">424</a>     <strong>public</strong> <strong>boolean</strong> registerPrefixCapability(String prefix,
<a name="425" href="#425">425</a>             Class&lt;? <strong>extends</strong> EntityProvider> capability, EntityProvider entityProvider) {
<a name="426" href="#426">426</a>         String key = getBiKey(prefix, capability);
<a name="427" href="#427">427</a>         <strong>return</strong> prefixMap.put(key, entityProvider) == <strong>null</strong>;
<a name="428" href="#428">428</a>     }
<a name="429" href="#429">429</a> 
<a name="430" href="#430">430</a>     <em>/**<em>*</em></em>
<a name="431" href="#431">431</a> <em>     * @deprecated use {@link #getProviderByPrefix(String)} instead</em>
<a name="432" href="#432">432</a> <em>     */</em>
<a name="433" href="#433">433</a>     <strong>public</strong> EntityProvider getProviderByReference(String reference) {
<a name="434" href="#434">434</a>         EntityReference ref = <strong>new</strong> EntityReference(reference);
<a name="435" href="#435">435</a>         <strong>return</strong> getProviderByPrefix(ref.prefix);
<a name="436" href="#436">436</a>     }
<a name="437" href="#437">437</a> 
<a name="438" href="#438">438</a> 
<a name="439" href="#439">439</a>     <em class="comment">// LISTENERS</em>
<a name="440" href="#440">440</a> 
<a name="441" href="#441">441</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="442" href="#442">442</a>     <strong>public</strong> &lt;T <strong>extends</strong> EntityProvider> <strong>void</strong> registerListener(EntityProviderListener&lt;T> listener, <strong>boolean</strong> includeExisting) {
<a name="443" href="#443">443</a>         <strong>if</strong> (listener == <strong>null</strong>) {
<a name="444" href="#444">444</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"listener cannot be null"</span>);
<a name="445" href="#445">445</a>         }
<a name="446" href="#446">446</a>         <em class="comment">// unregister first</em>
<a name="447" href="#447">447</a>         unregisterListener(listener);
<a name="448" href="#448">448</a>         <em class="comment">// get the filter values</em>
<a name="449" href="#449">449</a>         String prefix = listener.getPrefixFilter();
<a name="450" href="#450">450</a>         Class&lt;T> capability = listener.getCapabilityFilter();
<a name="451" href="#451">451</a>         <em class="comment">// make the key ensuring it is unique</em>
<a name="452" href="#452">452</a>         String key = prefix + <span class="string">":"</span> + capability + <span class="string">":"</span> + UUID.randomUUID();
<a name="453" href="#453">453</a>         <em class="comment">// store the listener</em>
<a name="454" href="#454">454</a>         listenerMap.put(key, listener);
<a name="455" href="#455">455</a>         <em class="comment">// do the immediate calls if requested</em>
<a name="456" href="#456">456</a>         <strong>if</strong> (includeExisting) {
<a name="457" href="#457">457</a>             <strong>if</strong> (capability == <strong>null</strong> &amp;&amp; prefix == <strong>null</strong>) {
<a name="458" href="#458">458</a>                 <em class="comment">// all</em>
<a name="459" href="#459">459</a>                 List&lt;T> providers = (List&lt;T>) getProvidersByCapability(EntityProvider.<strong>class</strong>);
<a name="460" href="#460">460</a>                 <strong>for</strong> (T provider : providers) {
<a name="461" href="#461">461</a>                     listener.run(provider);
<a name="462" href="#462">462</a>                 }
<a name="463" href="#463">463</a>             } <strong>else</strong> <strong>if</strong> (capability == <strong>null</strong>) {
<a name="464" href="#464">464</a>                 <em class="comment">// get by prefix</em>
<a name="465" href="#465">465</a>                 T provider = (T) getProviderByPrefix(prefix);
<a name="466" href="#466">466</a>                 <strong>if</strong> (provider != <strong>null</strong>) {
<a name="467" href="#467">467</a>                     listener.run(provider);
<a name="468" href="#468">468</a>                 }
<a name="469" href="#469">469</a>             } <strong>else</strong> <strong>if</strong> (prefix == <strong>null</strong>) {
<a name="470" href="#470">470</a>                 <em class="comment">// get by capability</em>
<a name="471" href="#471">471</a>                 List&lt;T> l = getProvidersByCapability(capability);
<a name="472" href="#472">472</a>                 <strong>for</strong> (T provider : l) {
<a name="473" href="#473">473</a>                     listener.run(provider);
<a name="474" href="#474">474</a>                 }
<a name="475" href="#475">475</a>             } <strong>else</strong> {
<a name="476" href="#476">476</a>                 <em class="comment">// get by prefix and capability</em>
<a name="477" href="#477">477</a>                 T provider = getProviderByPrefixAndCapability(prefix, capability);
<a name="478" href="#478">478</a>                 <strong>if</strong> (provider != <strong>null</strong>) {
<a name="479" href="#479">479</a>                     listener.run(provider);
<a name="480" href="#480">480</a>                 }
<a name="481" href="#481">481</a>             }
<a name="482" href="#482">482</a>         }
<a name="483" href="#483">483</a>     }
<a name="484" href="#484">484</a> 
<a name="485" href="#485">485</a>     <em>/**<em>*</em></em>
<a name="486" href="#486">486</a> <em>     * Called from {@link #registerEntityProvider(EntityProvider)} when registering a provider</em>
<a name="487" href="#487">487</a> <em>     */</em>
<a name="488" href="#488">488</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="489" href="#489">489</a>     <strong>private</strong> <strong>void</strong> callListener(EntityProviderListener providerListener, EntityProvider entityProvider) {
<a name="490" href="#490">490</a>         <em class="comment">// get the filter values</em>
<a name="491" href="#491">491</a>         String prefix = providerListener.getPrefixFilter();
<a name="492" href="#492">492</a>         Class&lt;? <strong>extends</strong> EntityProvider> capability = providerListener.getCapabilityFilter();
<a name="493" href="#493">493</a>         <em class="comment">// call the listener and give it the provider</em>
<a name="494" href="#494">494</a>         <strong>if</strong> (capability == <strong>null</strong> &amp;&amp; prefix == <strong>null</strong>) {
<a name="495" href="#495">495</a>             <em class="comment">// any</em>
<a name="496" href="#496">496</a>             providerListener.run(entityProvider);
<a name="497" href="#497">497</a>         } <strong>else</strong> <strong>if</strong> (capability == <strong>null</strong>) {
<a name="498" href="#498">498</a>             <em class="comment">// by prefix only</em>
<a name="499" href="#499">499</a>             <strong>if</strong> (prefix.equals(entityProvider.getEntityPrefix())) {
<a name="500" href="#500">500</a>                 providerListener.run(entityProvider);
<a name="501" href="#501">501</a>             }
<a name="502" href="#502">502</a>         } <strong>else</strong> <strong>if</strong> (prefix == <strong>null</strong>) {
<a name="503" href="#503">503</a>             <em class="comment">// by capability only</em>
<a name="504" href="#504">504</a>             <strong>if</strong> (capability.isAssignableFrom(entityProvider.getClass())) {
<a name="505" href="#505">505</a>                 providerListener.run(entityProvider);
<a name="506" href="#506">506</a>             }
<a name="507" href="#507">507</a>         } <strong>else</strong> {
<a name="508" href="#508">508</a>             <em class="comment">// by prefix and capability only</em>
<a name="509" href="#509">509</a>             <strong>if</strong> (prefix.equals(entityProvider.getEntityPrefix()) 
<a name="510" href="#510">510</a>                     &amp;&amp; capability.isAssignableFrom(entityProvider.getClass())) {
<a name="511" href="#511">511</a>                 providerListener.run(entityProvider);
<a name="512" href="#512">512</a>             }
<a name="513" href="#513">513</a>         }
<a name="514" href="#514">514</a>     }
<a name="515" href="#515">515</a> 
<a name="516" href="#516">516</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="517" href="#517">517</a>     <strong>public</strong> &lt;T <strong>extends</strong> EntityProvider> <strong>void</strong> unregisterListener(EntityProviderListener&lt;T> listener) {
<a name="518" href="#518">518</a>         <strong>if</strong> (listener == <strong>null</strong>) {
<a name="519" href="#519">519</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"listener cannot be null"</span>);
<a name="520" href="#520">520</a>         }
<a name="521" href="#521">521</a>         <strong>if</strong> (! listenerMap.isEmpty()) {
<a name="522" href="#522">522</a>             <em class="comment">// try to find by the object equality and then remove</em>
<a name="523" href="#523">523</a>             String key = <strong>null</strong>;
<a name="524" href="#524">524</a>             <strong>for</strong> (Entry&lt;String, EntityProviderListener> entry : listenerMap.entrySet()) {
<a name="525" href="#525">525</a>                 <strong>if</strong> (listener.equals(entry.getValue())) {
<a name="526" href="#526">526</a>                     key = entry.getKey();
<a name="527" href="#527">527</a>                     <strong>break</strong>;
<a name="528" href="#528">528</a>                 }
<a name="529" href="#529">529</a>             }
<a name="530" href="#530">530</a>             <strong>if</strong> (key != <strong>null</strong>) {
<a name="531" href="#531">531</a>                 listenerMap.remove(key);
<a name="532" href="#532">532</a>             }
<a name="533" href="#533">533</a>         }
<a name="534" href="#534">534</a>     }
<a name="535" href="#535">535</a> 
<a name="536" href="#536">536</a> 
<a name="537" href="#537">537</a>     <em class="comment">// STATICS</em>
<a name="538" href="#538">538</a> 
<a name="539" href="#539">539</a>     <em class="comment">// BIKEY methods</em>
<a name="540" href="#540">540</a>     <strong>protected</strong> <strong>static</strong> String getBiKey(String prefix, Class&lt;? <strong>extends</strong> EntityProvider> clazz) {
<a name="541" href="#541">541</a>         <strong>return</strong> prefix + <span class="string">"/"</span> + clazz.getName();
<a name="542" href="#542">542</a>     }
<a name="543" href="#543">543</a> 
<a name="544" href="#544">544</a>     <strong>protected</strong> <strong>static</strong> String getPrefix(String bikey) {
<a name="545" href="#545">545</a>         <strong>int</strong> slashpos = bikey.indexOf('/');
<a name="546" href="#546">546</a>         <strong>return</strong> bikey.substring(0, slashpos);
<a name="547" href="#547">547</a>     }
<a name="548" href="#548">548</a> 
<a name="549" href="#549">549</a>     <strong>protected</strong> <strong>static</strong> String getCapabilityName(String bikey) {
<a name="550" href="#550">550</a>         <strong>int</strong> slashpos = bikey.indexOf('/');
<a name="551" href="#551">551</a>         String className = bikey.substring(slashpos + 1);
<a name="552" href="#552">552</a>         <strong>return</strong> className;
<a name="553" href="#553">553</a>     }
<a name="554" href="#554">554</a> 
<a name="555" href="#555">555</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="556" href="#556">556</a>     <strong>protected</strong> <strong>static</strong> Class&lt;? <strong>extends</strong> EntityProvider> getCapability(String bikey) {
<a name="557" href="#557">557</a>         <strong>int</strong> slashpos = bikey.indexOf('/');
<a name="558" href="#558">558</a>         String className = bikey.substring(slashpos + 1);
<a name="559" href="#559">559</a>         Class&lt;?> c;
<a name="560" href="#560">560</a>         <strong>try</strong> {
<a name="561" href="#561">561</a>             c = Class.forName(className);
<a name="562" href="#562">562</a>         } <strong>catch</strong> (ClassNotFoundException e) {
<a name="563" href="#563">563</a>             <strong>try</strong> {
<a name="564" href="#564">564</a>                 c = Class.forName(className, <strong>true</strong>, Thread.currentThread().getContextClassLoader());
<a name="565" href="#565">565</a>             } <strong>catch</strong> (ClassNotFoundException e1) {
<a name="566" href="#566">566</a>                 <strong>throw</strong> <strong>new</strong> RuntimeException(<span class="string">"Could not get Class from classname: "</span> + className, e);
<a name="567" href="#567">567</a>             }
<a name="568" href="#568">568</a>         }
<a name="569" href="#569">569</a>         <strong>return</strong> (Class&lt;? <strong>extends</strong> EntityProvider>) c;
<a name="570" href="#570">570</a>     }
<a name="571" href="#571">571</a> 
<a name="572" href="#572">572</a>     <em class="comment">// OTHER</em>
<a name="573" href="#573">573</a> 
<a name="574" href="#574">574</a>     <em>/**<em>*</em></em>
<a name="575" href="#575">575</a> <em>     * Get the capabilities implemented by this provider</em>
<a name="576" href="#576">576</a> <em>     * </em>
<a name="577" href="#577">577</a> <em>     * @param provider</em>
<a name="578" href="#578">578</a> <em>     * @return</em>
<a name="579" href="#579">579</a> <em>     */</em>
<a name="580" href="#580">580</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="581" href="#581">581</a>     <strong>protected</strong> <strong>static</strong> List&lt;Class&lt;? <strong>extends</strong> EntityProvider>> extractCapabilities(EntityProvider provider) {
<a name="582" href="#582">582</a>         List&lt;Class&lt;?>> superclasses = ReflectUtils.getSuperclasses(provider.getClass());
<a name="583" href="#583">583</a>         Set&lt;Class&lt;? <strong>extends</strong> EntityProvider>> capabilities = <strong>new</strong> HashSet&lt;Class&lt;? <strong>extends</strong> EntityProvider>>();
<a name="584" href="#584">584</a> 
<a name="585" href="#585">585</a>         <strong>for</strong> (Class&lt;?> superclazz : superclasses) {
<a name="586" href="#586">586</a>             <strong>if</strong> (superclazz.isInterface() &amp;&amp; EntityProvider.<strong>class</strong>.isAssignableFrom(superclazz)) {
<a name="587" href="#587">587</a>                 capabilities.add((Class&lt;? <strong>extends</strong> EntityProvider>) superclazz);
<a name="588" href="#588">588</a>             }
<a name="589" href="#589">589</a>         }
<a name="590" href="#590">590</a>         <strong>return</strong> <strong>new</strong> ArrayList&lt;Class&lt;? <strong>extends</strong> EntityProvider>>(capabilities);
<a name="591" href="#591">591</a>     }
<a name="592" href="#592">592</a> 
<a name="593" href="#593">593</a>     <strong>public</strong> <strong>static</strong> <strong>class</strong> EntityProviderComparator implements Comparator&lt;EntityProvider>, Serializable {
<a name="594" href="#594">594</a>         <strong>public</strong> <strong>final</strong> <strong>static</strong> <strong>long</strong> serialVersionUID = 1l;
<a name="595" href="#595">595</a>         <strong>public</strong> <strong>int</strong> compare(EntityProvider o1, EntityProvider o2) {
<a name="596" href="#596">596</a>             <strong>return</strong> o1.getEntityPrefix().compareTo(o2.getEntityPrefix());
<a name="597" href="#597">597</a>         }
<a name="598" href="#598">598</a>     }
<a name="599" href="#599">599</a> 
<a name="600" href="#600">600</a>     <strong>public</strong> <strong>static</strong> <strong>class</strong> ClassComparator implements Comparator&lt;Class&lt;?>>, Serializable {
<a name="601" href="#601">601</a>         <strong>public</strong> <strong>final</strong> <strong>static</strong> <strong>long</strong> serialVersionUID = 1l;
<a name="602" href="#602">602</a>         <strong>public</strong> <strong>int</strong> compare(Class&lt;?> o1, Class&lt;?> o2) {
<a name="603" href="#603">603</a>             <strong>return</strong> o1.getName().compareTo(o2.getName());
<a name="604" href="#604">604</a>         }
<a name="605" href="#605">605</a>     }
<a name="606" href="#606">606</a> 
<a name="607" href="#607">607</a> 
<a name="608" href="#608">608</a>     <em class="comment">// GETTERS and SETTERS</em>
<a name="609" href="#609">609</a> 
<a name="610" href="#610">610</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="611" href="#611">611</a> <em class="comment">     * @see org.sakaiproject.entitybus.entityprovider.EntityProviderManager#getRequestStorage()</em>
<a name="612" href="#612">612</a> <em class="comment">     */</em>
<a name="613" href="#613">613</a>     <strong>public</strong> RequestStorageWrite getRequestStorage() {
<a name="614" href="#614">614</a>         <strong>return</strong> requestStorage;
<a name="615" href="#615">615</a>     }
<a name="616" href="#616">616</a> 
<a name="617" href="#617">617</a>     <strong>public</strong> <strong>void</strong> setRequestStorage(RequestStorageWrite requestStorage) {
<a name="618" href="#618">618</a>         <strong>this</strong>.requestStorage = requestStorage;
<a name="619" href="#619">619</a>     }
<a name="620" href="#620">620</a> 
<a name="621" href="#621">621</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="622" href="#622">622</a> <em class="comment">     * @see org.sakaiproject.entitybus.entityprovider.EntityProviderManager#getRequestGetter()</em>
<a name="623" href="#623">623</a> <em class="comment">     */</em>
<a name="624" href="#624">624</a>     <strong>public</strong> RequestGetterWrite getRequestGetter() {
<a name="625" href="#625">625</a>         <strong>return</strong> requestGetter;
<a name="626" href="#626">626</a>     }
<a name="627" href="#627">627</a> 
<a name="628" href="#628">628</a>     <strong>public</strong> <strong>void</strong> setRequestGetter(RequestGetterWrite requestGetter) {
<a name="629" href="#629">629</a>         <strong>this</strong>.requestGetter = requestGetter;
<a name="630" href="#630">630</a>     }
<a name="631" href="#631">631</a> 
<a name="632" href="#632">632</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="633" href="#633">633</a> <em class="comment">     * @see org.sakaiproject.entitybus.entityprovider.EntityProviderManager#getEntityProperties()</em>
<a name="634" href="#634">634</a> <em class="comment">     */</em>
<a name="635" href="#635">635</a>     <strong>public</strong> EntityPropertiesService getEntityProperties() {
<a name="636" href="#636">636</a>         <strong>return</strong> entityProperties;
<a name="637" href="#637">637</a>     }
<a name="638" href="#638">638</a> 
<a name="639" href="#639">639</a>     <strong>public</strong> <strong>void</strong> setEntityProperties(EntityPropertiesService entityProperties) {
<a name="640" href="#640">640</a>         <strong>this</strong>.entityProperties = entityProperties;
<a name="641" href="#641">641</a>     }
<a name="642" href="#642">642</a> 
<a name="643" href="#643">643</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="644" href="#644">644</a> <em class="comment">     * @see org.sakaiproject.entitybus.entityprovider.EntityProviderManager#getEntityProviderMethodStore()</em>
<a name="645" href="#645">645</a> <em class="comment">     */</em>
<a name="646" href="#646">646</a>     <strong>public</strong> EntityProviderMethodStore getEntityProviderMethodStore() {
<a name="647" href="#647">647</a>         <strong>return</strong> entityProviderMethodStore;
<a name="648" href="#648">648</a>     }
<a name="649" href="#649">649</a> 
<a name="650" href="#650">650</a>     <strong>public</strong> <strong>void</strong> setEntityProviderMethodStore(EntityProviderMethodStore entityProviderMethodStore) {
<a name="651" href="#651">651</a>         <strong>this</strong>.entityProviderMethodStore = entityProviderMethodStore;
<a name="652" href="#652">652</a>     }
<a name="653" href="#653">653</a> 
<a name="654" href="#654">654</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

